home *** CD-ROM | disk | FTP | other *** search
/ Amiga Tools 4 / Amiga Tools 4.iso / grafix / tools / xipaintmodule / hhsxipaintmod.readme < prev    next >
Text File  |  1996-02-26  |  16KB  |  345 lines
  1. HHsFastUniversalXiPaintModule 4.0 (incl. PhotoCD- & TrueColorAnim-support)
  2. =================================
  3.  
  4. new in V4.0: Downscaled loading support: Loading big pictures in downscaled
  5.         form can save much memory and time. Finally a way to get
  6.         your "too big" pictures into XiPaint...
  7.     Included JPeg support (esp. useful e.g. for downscaled loading)
  8.     Automatic installation script added.
  9. new in V3.0: TrueColor animation saving support in HHsYUVSq animation format
  10.     ->create your own TrueColor animations for playback on CyberGraphX
  11.       with CyberTVPlayer or on EGS with EGSTVPlayer <-
  12.     Including ARexx script for automatic conversion of picture
  13.       directories into HHsYUVSq animation format
  14.  
  15. This universal module can be used to load images in many file formats
  16. (more than 20 and additionally Datatypes) very fast into XiPaint (including
  17. optional downscaling) and to create TrueColor animations in HHsYUVSq
  18. animation format.
  19.  
  20. Installation
  21. ------------
  22.  
  23. The module can be installed automatically with the included script: Simply
  24. start it and select the XiPaint main directory in the file requester. The
  25. needed files will then be installed.
  26.  
  27. If you prefer manual installation: "hhsxipaintmod.xio" is the main module
  28. and should be copied to the XiPaint/Modules directory for XiPaint 3.2 and up.
  29. For older versions the module should be copied to the XiPaint main directory
  30. and the additional ARexx script "hhsxipaintloader.rx" should come into
  31. the XiPaint/Makro directory. For all versions the "makeanim.rx" script can
  32. be installed in the XiPaint/Makro or XiPaint main directory.
  33.  
  34. Usage
  35. -----
  36.  
  37. 1) XiPaint 3.2 or higher: The module will be detected by XiPaint 3.2
  38.  
  39.   a) as "HHsUniversalLoader", "Universal_50%_size" and "Universal_25%_size"
  40.      which you can then select in the Settings/Loaders list of loader
  41.      modules. The Loader will be automatically used (if selected) for
  42.      opening of new projects and for loading into existing projects.
  43.      To load pictures in half or quarter size, use the %_size loaders.
  44.  
  45.   b) as "HHsYUVSqAnimation" which you can then select in the Settings/Savers
  46.      list of saver modules. To create a new animation, select a new filename
  47.      for saving with this format; to append a frame to an existing animation,
  48.      select the existing animation file for saving. XiPaint will warn you
  49.      that the file is overwritten, but the module will only append the frame
  50.      and not delete the old file.
  51.  
  52.      Please note: Image width must be in the range 80 to 360 (even size will
  53.      be generated); Image height must be in the range 64 to 310. To append
  54.      frames to an animation, the image size in XiPaint must match the frame
  55.      size of the file you want to append to. Otherwise (or if you specify
  56.      not a HHsYUVSq anim file) an error will occur.
  57.  
  58.    To automatically create an animation from a directory of pictures you
  59.    can use the included ARexx script "makeanim.rx". This will do automatic
  60.    downscaling. Please see notes below.
  61.  
  62. -> XiPaint 3.2-CD: If you have problems with XiPaint 3.2 on CD-ROM,
  63.    you should check your file system; some CD file systems
  64.    only support upper case file names; XiPrefs looks only for
  65.    lower case xout-libraries; use another file system or rename
  66.    the libraries to lowercase manually (on your harddisk) like
  67.    rename XiPaint/libs/XOUT_C.LIBRARY "XiPaint/libs/xout_c.library"
  68.    etc... This should solve your problems.
  69.  
  70. 2) XiPaint 3.0/3.1
  71.  
  72.   As thoose XiPaint versions have no direct support for external modules,
  73.   you can only access it by the included ARexx scripts.
  74.  
  75.   a) For loading: Execute the "hhsxipaintloader.rx" macro (with the
  76.      menu function Macro/Execute).
  77.      It will then switch to the WB screen and display a standard
  78.      file requester. You can then select a file for loading. The
  79.      picture will be loaded if possible and transferred to XiPaint
  80.      as a new project window. Then the WB screen is sent back so
  81.      that XiPaint screen should appear in front again. Some XiPaint
  82.      versions add absolute path names of new project windows to the
  83.      relative standard path. I can't work around this, so such
  84.      pictures will get wrong project names with such versions (Only
  85.      use SaveAs to save such pictures). Please upgrade to XiPaint 3.2
  86.      to get a more convenient access to my module...
  87.  
  88.   b) For TrueColor animation creation: Execute the automatic script
  89.      "makeanim.rx"; see below for details.
  90.  
  91. Supported file formats
  92. ----------------------
  93.  
  94. Supported file formats for loading:
  95.  
  96. * IFF-ILBM (all standard formats 1 to 8Bit, EHB, HAM6, HAM8, 24Bit)
  97. * JPeg (color and greyscale; see notes below)
  98. * PhotoCD (Base format 768x512 or 512x768 (portrait); linear 24Bit colors)
  99. * PPM/PGM/PBM (P1&P4 b&w, P5 grey, P6 color)
  100. * QRT (also known as dump format by PD raytracers as POV-Ray)
  101. * Targa (RLE compr.&uncompr. 1/8/15/16/24/32Bit;incl. interleaved)
  102. * PCX (compr.&uncompr. EGA1-4Bit, VGA 8Bit grey/Colormap and 24Bit)
  103. * MacPaint (b&w compressed 1Bit format; datafork only)
  104. * BMP (uncompr. 24Bit RGB,1Bit,4Bit or 8Bit Colormap; RLE compressed 8Bit,1Bit)
  105. * TIF (packbit-compr.&uncompr. 24Bit,1-8Bit grey/Color Motorola&Intel formats)
  106. * EGS7.x window iconification file format
  107. * DEEP (compr.&uncompr. 24Bit and 32Bit)
  108. * RGB formats (RGB8, RGBN, RGB5)
  109. * ACBM formats (1 to 8Bit, incl. HAM6/HAM8)
  110. * FBM formats (8Bit grey/color and 24Bit)
  111. * IFF-PBM (DPII) format
  112. * Sun raster (1Bit, 8Bit grey/color and 24Bit uncompressed)
  113. * YUV (color 1:1:1, 2:1:1, 4:1:1 and greyscale)
  114. * VLAB raw (color 1:1:1, 2:1:1, 4:1:1 and greyscale)
  115. * HHsYUVSq sequence format (sequential or random access; only first frame)
  116. * HHsXRL formats (1-8Bit ColorMap incl. HAM6/8, 8Bit grey, 24Bit RGB compressed)
  117. * binary-EPS bitmaps (RGB and CMYK; this function is experimental)
  118. * TBCPlus frames&fields
  119.  
  120. * DataType (incl. first frame of animations with Anim-Datatypes)
  121.  
  122. Supported file formats for saving:
  123.  
  124. * HHsYUVSq animation format
  125.  
  126. Automatic creation of HHsYUVSq TrueColor animations
  127. ---------------------------------------------------
  128.  
  129. With the script "makeanim.rx" you can automatically convert a directory
  130. of pictures into an HHsYUVSq animation file. Just start the script
  131. from XiPaint as macro or from Workbench or Shell. It should work with
  132. all XiPaint 3.x and up versions. If you start it from XiPaint, you will
  133. probably have to switch to WB screen manually; there you get a requester
  134. asking for the source directory which should contain the pictures
  135. (all of the same size). Then you are asked for the destination animation
  136. file. Then the automatic conversion is started. Pictures are downscaled
  137. if necessary. You can watch the pictures beeing loaded in XiPaint. They
  138. are loaded in alphabetical order (users of old XiPaint versions prior to
  139. V3.2 should NOT play with XiPaint during this process as this can
  140. block the whole system). With newer versions it should be save to
  141. use XiPaint for other things during the process except loading as
  142. this would interact with the frame loading! If the conversion has finished,
  143. the last picture will remain in XiPaint as a project. You can close
  144. this manually.
  145.  
  146. To play the animations use my freeware player programs
  147. CyberTVPlayer for TrueColor playback on CyberGraphX compatible
  148. boards (incl. Draco) or EGSTVPlayer for TrueColor playback on
  149. EGS compatible boards. CyberTVPlayer can also be used without
  150. CyberGraphX for reduced viewing (upto 256 colors) on all Amigas
  151. with at least OS3.0.
  152.  
  153. Additional notes: The loading/saving is done with HHsXiPaintMod.xio
  154. only; so you can only load pictures in one of the supported formats
  155. (see above). If you want to make animations from pictures in other formats,
  156. you have to load and save them with the appropriate modules manually.
  157. But anyway, the module now seems to support nearly all formats...
  158.  
  159. Downscaled loading
  160. ------------------
  161.  
  162. The loader module now supports direct downscaled loading in XiPaint 3.2
  163. and higher; simply select the appropriate loader version in the list.
  164. Currently the loader should appear 3 times: HHsUniversalLoader for full
  165. size, Universal_50%_Size for half size and Universal_25%_Size for quarter
  166. size. For most file formats (e.g. IFF, DEEP, JPeg, PCX, PPM, Targa, ...)
  167. the downscaling is done on a line by line base, so that memory will only
  168. be needed for the reduced size. This should enable you to get big
  169. pictures into XiPaint without memory problems.
  170.  
  171. General notes
  172. -------------
  173.  
  174. There are currently no error requesters for loading (if a file can not be
  175. loaded nothing will happen). For saving error requesters are included.
  176.  
  177. If you register for the XiPaint modules you will receive a
  178. keyfile together with the latest version of the modules. The
  179. keyfile will enable you to use future demo versions as update.
  180.  
  181. The demo version will load and save all pictures in greyscales, but
  182. usually at the same speed as the full version would do in color.
  183.  
  184. XiPaintModules need at least OS2.04 (OS3.x for Datatype usage).
  185.  
  186. All loading functions (except JPeg: This software is based in part on the work
  187. of the independent JPeg Group) have been written in Assembler and optimised for
  188. extremely high speed. An exception to this is the JPeg format, which is
  189. written in C and based on the usual code of the indipendent JPeg group.
  190. I created the fast loading functions mainly for my famous shareware programs
  191. *** CyberShow Professional *** (universal viewer and slideshow program
  192. for all OS3.x Amigas and Dracos and esp. for CyberGraphX users), EGSPhotoAlbum
  193. Prof. and EGS-TV Prof.; When new formats are implemented for my other
  194. programs (or the speed is improved further), I will usually also update
  195. the modules, which registered user can then use due to the keyfile concept.
  196.  
  197. The JPeg format has been included in this module mainly for the comfort
  198. of the users (as otherwise for JPeg another loader module would have to
  199. be seleted) and to enable JPeg loading in downscaled form, which can be
  200. very useful. Now you can also create animations in HHsYUVSq animation
  201. format from JPeg pictures with the automatic ARexx script. The loading
  202. speed of the JPeg code (for pictures in full size) is unfortunately
  203. currently not very fast. Downscaled loading of JPeg can be much faster.
  204.  
  205. Registration
  206. ------------
  207.  
  208. You can register for the module at the small add-on price of only 8US$ or
  209. 10DM if you order it together with one of my other shareware programs,
  210. e.g. CyberShow, the universal viewer and slideshow program for all Amigas
  211. with at least OS3.0 (loading the same formats as the XiPaintModule and
  212. additional JPeg) or EGSPhotoAlbum or EGS-TV. Please use the registration
  213. forms of thoose programs and specify your add-on module order there and
  214. include the extra amount.
  215.  
  216. Otherwise you should use the included registration form to register:
  217.  
  218. If you only want to register for the module, the registration fee is
  219. 18US$ outside europe or 20DM in europe. You will also get the latest demo
  220. versions of my other programs. Additional modules (e.g. UniversalGIO for
  221. Photogenics or FastIFXModules for ImageFX) can be ordered at the lower
  222. add-on price.
  223.  
  224. If you are already a registered user of one of my programs and now want to
  225. register for the modules, the registration fee is 13US$ outside europe or
  226. 15DM (in europe). This includes the latest versions of my programs as update.
  227. Additional modules (e.g. UniversalGIO for Photogenics or FastIFXModules for
  228. ImageFX) can be ordered at the lower add-on price.
  229.  
  230. (Special note for users in germany only: Wenn Sie schon registrierter Benutzer
  231.  eines meiner Shareware-Programme sind und sich Ihre Anschrift nicht
  232.  geändert hat, können Sie die Module direkt per Überweisung bestellen.
  233.  Als Verwendungszweck geben Sie bitte "XiPaintMod für ...." an, wobei Sie
  234.  das Programm was Sie schon haben und die Registriernummer angeben.
  235.  Zusätzlich möglichst auch noch Name/Anschrift; die Bankverbindung:
  236.  Konto-Nr. 5740147 BLZ 310 500 00 Stadtspark. Mönchengladbach)
  237.  (No bank transfers from outside germany!)
  238.  
  239. Send your filled in registration form together with cheque, international
  240. postal money order or banknotes to:
  241.  
  242.                         Helmut Hoffmann
  243.             Rubensstrasse 4
  244.             D-41063 Mönchengladbach
  245.  
  246.             Germany
  247.  
  248. You can currently also contact me by EMail (e.g. for suggestions):
  249.  
  250.         hhoff@pool.informatik.rwth-aachen.de
  251.  
  252. No registrations by EMail! If you want to register, please write by ordinary mail
  253. to my address above.
  254.  
  255. Special Thanks
  256. --------------
  257.  
  258. My special thanks go to Mr. Thomas Dorn and Ossowski's Schatztruhe for
  259. providing me with XiPaint.
  260.  
  261. Disclaimer
  262. ----------
  263.  
  264. This software (program and documentation) is provided "as is" and
  265. comes with no warranty, either expressed or implied.
  266. The author is in no way responsible for any damage or loss that may
  267. occur due to direct or indirect usage of this software. You use
  268. this software entirely at your own risk.
  269.  
  270. Copyright and Distribution
  271. --------------------------
  272.  
  273. HHsFastUniversalXiPaintModule (module and documentation) is copyright by
  274.  
  275.                         Helmut Hoffmann
  276.             Rubensstrasse 4
  277.             D-41063 Mönchengladbach
  278.  
  279.             Germany
  280.  
  281. The demo version may be freely distributed and used as
  282. long as the following conditions are met:
  283.  
  284. 1) All files have to be kept together
  285.  
  286. 2) No file may be modified or crunched/packed.
  287.  
  288.    The only official way to distribute the demo packed is the
  289.    original xipaintmod.lha archive.
  290.    The modules may not be disassembled or analysed. The limitations
  291.    integrated in the demo version may under no circumstance be removed
  292.    or bypassed.
  293.  
  294. 3) Distributors may only charge for the duplication process (including media)
  295.    and not for the software. Theese charges may not exceed the following
  296.    limits: a) Demo on a PD-disk: 7$ (US-dollar) including
  297.               postage&packing (in Germany: 10DM)
  298.        b) Demo on a PD-CD-ROM: 40$ (US-dollar) including
  299.               postage&packing (in Germany: 60DM)
  300.        c) Demo on a BBS/Mailbox/ftp-site or other electronically
  301.               callable system: Maximum charge 3$ (US-dollar) (in Germany: 5DM)
  302.               for downloading
  303.    Anyway, it must be made explictly clear to the buyer, that he does not
  304.    pay for the modules (demo) itself but only for the duplication service.
  305.  
  306. 4) It is not allowed to distribute this demo with any commercial product
  307.    without a written permission by me. One exception is the distribution of
  308.    the demo version with products not exceeding the above price limits (e.g.
  309.    a cover-disk magazine for 7$ or less).
  310.  
  311.    The demo version may be included with XiPaint.
  312.  
  313. 5) The registered version may not be redistributed. It may only run on one
  314.    machine per registration. It is allowed to make a backup copy of the
  315.    original disk.
  316.  
  317. Version history
  318. ---------------
  319.  
  320. V0.1 (7th aug. 95): Prerelease for loading functions
  321. V0.2 (20th aug. 95): Prerelease for loading by ARexx script:
  322.             added Request option and screen switching functions
  323. V1.0 (15th sep. 95): First official release for use by Arexx script (usable
  324.             with XiPaint 3.x)
  325. V2.0 (21st sep. 95): First release with direct loader module support for
  326.             XiPaint 3.2 (just copy the .xio file into the
  327.             XiPaint/Modules directory and configure it as loader)
  328. V2.1 (9th oct. 95): Extended TIF loader to support "Intel" byte order files
  329.             and more variants
  330. V3.0 (11th dec. 95): TrueColor animation saving: extended module to support
  331.             saving in HHsYUVSq animation format;
  332.             included ARexx script to automatically create such
  333.             animations from multiple pictures
  334.              Extended IFF loader to accept 0-sized chunks
  335.              Loader can now load bigger pictures into smaller projects
  336.              Integrated downscaling support (only usable by scripts)
  337. V4.0 (9th feb. 96): Support for downscaled loading (50% size, 25% size) by
  338.             additional entries in the XiPaint 3.2 loader list
  339.             Added JPeg loading support (see special notes for JPeg!)
  340.             Included script for automatic installation of modules
  341.             Bug fixes in makeanim.rx script: now should also work
  342.             if other project windows exist during anim creation
  343.             Extended IFF loader to accept unusual sized color maps
  344.  
  345.